home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / pcburm10.zip / PCBURM.DOC < prev    next >
Text File  |  1992-08-21  |  11KB  |  270 lines
  1.                                 PCBURM v1.0
  2.                                 -----------
  3.  
  4.                          PCBoard User Ratio Monitor
  5.  
  6.                    A PCBoard File/Byte Download Monitor
  7.  
  8.                                Version 1.0
  9.  
  10.                             For PCBoard v14.5a
  11.  
  12.  
  13.                                 - - - - -
  14.  
  15.  
  16.                        Copyright 1992 - Robert Neal
  17.                                 317 Hickory
  18.                            Romeoville, IL  60441
  19.  
  20.                                Support BBS:
  21.                        Corporate Headquarters BBS
  22.                      Node #1: (815) 886-3233 v.32bis
  23.                Node #2: (815) 886-9381 2400 (soon v.32bis)
  24.  
  25.  
  26.  
  27.  
  28.  
  29.                            PROGRAM INFORMATION
  30.                            ===================
  31.  
  32. PCBoard User Ratio Monitor (PCBURM) is a utility door written for
  33. PCBoard v14.5a. PCBURM will enforce your desired ratios with each call
  34. the user makes to your board. PCBURM was written because PCBoard lacks a
  35. ratio enforcement method that is easy to use and understand, and one
  36. that can be run "real time". In looking around for similar products,
  37. everyone I've seen seem to be overkill, didn't effectively handle
  38. particular user requirements or just plain didn't seem to work.
  39.  
  40. In creating PCBURM, it was designed to be just one thing, a file/byte
  41. monitoring and enforcement tool for PCBoard. PCBURM will check for
  42. either a file ratio, byte ratio or both, sysop defined. There is no
  43. "banking" features, message ratio monitoring or things of that sort.
  44. This was decided so that PCBURM would be SIMPLE AND EASY for any sysop
  45. to get up and running in a matter of minutes.
  46.  
  47. Features of PCBURM:
  48.         o Support for baud rates up to 115,200 bps
  49.         o Support for non-standard COM IRQ's
  50.         o Complete monitoring of COM ports for carrier loss
  51.         o Option to display comment to user
  52.         o Full Multi-Node support
  53.         o Sysop function keys are supported
  54.         o Most of all - SIMPLE to use
  55.  
  56.  
  57.  
  58.  
  59.                       PROGRAM INSTALLATION/OPERATION
  60.                       ==============================
  61.  
  62.  
  63. Step #1: - Create configuration file
  64. ========
  65.  
  66. Edit PCBURM configuration file, PCBURM.CFG. Use your favorite text
  67. editor to edit this file.
  68.  
  69. The items in the configuration file are as follows, do not include the
  70. comment information which begins the the "<-" characters:
  71.  
  72. C:\PCB\USERS.SYS   <- *Line 1: Full path/filename to your USERS.SYS file
  73. Corp Headquarters  <-  Line 2: Name of your BBS
  74. Bob                <-  Line 3: First name of sysop
  75. Neal               <-  Line 4: Second name of sysop
  76. 0                  <-  Line 5: Registration # - 0=unregistered
  77. PCBURM.LOG         <-  Line 6: Full path/filename of log file to create
  78. 1                  <-  Line 6: File credit given to new users
  79. 50000              <-  Line 7: Byte credit given to new users
  80.  
  81.  
  82. (*) - PCBURM supports the PCB environment variables, %PCBDRIVE% and
  83. %PCBDIR%. Those running a multi-node system may which to replace Line 1
  84. with the following:
  85.  
  86.                 %PCBDRIVE%%PCBDIR%\USERS.SYS
  87.  
  88. PCBURM will read the current PCBoard drive and directory from these
  89. variables.
  90.  
  91. The log file created will include the name of the user, node used,
  92. security level assigned to the user as well as the date and a brief text
  93. line explaining what ratio enforcements were placed on the user. If a
  94. user exceeded his requirements, the log file will include the current
  95. ratios of the user at the time the program monitored his activity.
  96.  
  97. A little explanation may be in order for LINE 7 and LINE 8. These lines
  98. are used to give "free" credits to new users. If you would like to grant
  99. some "free" credits to a user, place the values here. In the above
  100. example, a user would be given credit for one upload and 50,000 bytes.
  101. If a user was given a 5:1 file ratio requirement, he could then download
  102. 5 files before needing to upload anything. Program would then restrict
  103. download ability until a file was uploaded. Same explanation for the
  104. byte credit, user could download 250,000 bytes if a 5:1 ratio was in
  105. place before he would need to upload anything. This option allows new
  106. users access to your file area without requiring an initial upload.
  107. Please note that this is used internally to the program. It will not
  108. actually add this information to the users file, keeping your user
  109. file statistics accurate.
  110.  
  111.  
  112.  
  113. Step #2: - Create file ratio requirements file
  114. ========
  115.  
  116. Edit the requirement file, PCBURM.REQ. Again, use your favorite text
  117. editor to edit this file: The format is as follows:
  118.  
  119. SECURITY LEVEL, FILE RATIO, BYTE RATIO, USER COMMENT
  120.  
  121. For example:
  122.  
  123. 30,5,10,Regular User
  124. 40,10,20,Supporting User - Thanks for your payment
  125. 200,0,0,Sysop
  126. 999,1,1,Unknown Access Level - Please inform sysop
  127.  
  128. In the above example, the first line is for a security level 30 user. He
  129. has a 5:1 file ratio requirement, a 10:1 byte ratio requirement. The
  130. USER COMMENT field ("Regular User") will be displayed as part of the
  131. user statistics displayed by the program. You can use this field to put
  132. any information you desire, maybe enter information about subscription
  133. that your board may offer.
  134.  
  135. In the second example, this is for a security level 40 user. He has a
  136. 10:1 file ratio requirement and a 20:1 byte ratio requirement.
  137.  
  138. In the third example, this is a security level 200 user. The file and
  139. byte ratios have been set to "0", this informs PCBURM that this user is
  140. exempt for maintaining any ratio requirements (might be used for
  141. subscribing user, co-sysops and sysops). You may set the byte and/or
  142. file ratio to zero if you do not with to enforce a ratio requirement.
  143.  
  144. The last example is recommended as the last line for every PCBURM.REQ
  145. file. This is used as the DEFAULT security ratio. If a security level is
  146. not found in the line preceeding this last line, these ratios will be
  147. assigned to the user. Using the above example, if the user had a
  148. security level of 60, PCBURM would use the file requirements as shown on
  149. this line as a level 60 was not previously assigned a ratio requirement.
  150.  
  151.  
  152.  
  153. Step #3 - Setup PCBURM as a door
  154. =======
  155.  
  156. Setup PCBURM as a PCBoard Door.  Run PCBSetup, edit the door security
  157. file and add the following line:
  158.  
  159.                                   USER DOOR
  160.  Filename    Password   Sec Login SYS  SYS  Shell Path to DOOR Files
  161. ══════════ ════════════ ═══ ═════ ════ ════ ═════ ═══════════════════     
  162. PCBURM                   0    Y    Y    N     Y
  163.  
  164. The "Login" and "Shell" are both optional. If you have enough memory, it
  165. is recommended that you use the "shell" option of PCBoard. The USERS.SYS
  166. field must be set to Y or PCBURM will not work!
  167.  
  168.  
  169. Step #4 - Create script file
  170. =======
  171.  
  172. Edit the PCBURM door script, again using your favorite text editor.
  173. Below is an example of a suggested script (example presumes PCBURM is
  174. located on drive "C" and in directory "PCBURM"):
  175.  
  176.      @ECHO OFF
  177.      C:
  178.      CD \PCBURM
  179.      PCBURM PCBURM.CFG
  180.      %PCBDRIVE%
  181.      CD %PCBDIR%
  182.      IF (%INPCB%)==(Y) EXIT
  183.      BOARD
  184.  
  185. The line "IF (%INPCB%)==(Y) EXIT" is used to exit from shelled doors. If
  186. you won't run PCBURM as a shelled door, it may be removed.
  187.  
  188. PCBURM supports COM1-4, using standard IRQ's. If you wish to use a
  189. non-standard IRQ, add the IRQ number after the configuration file name.
  190. For example "PCBURM PCBURM.CFG /5" (tells PCBURM to use IRQ 5 instead of
  191. standard IRQ value). No parameter is required if using standard IRQ
  192. values.
  193.  
  194.  
  195.  
  196. That's all there is to do. PCBURM uses will adjust the daily download
  197. bytes allowed as indicated in the PWRD file to monitor and enforce the
  198. file/byte ratio's. If you have used another file ratio enforcement
  199. program, check to see that you have re-entered this information in the
  200. PWRD file (some ratio enforcers have required you to zero out this
  201. information. Not PCBURM, PCBURM reads this information.
  202.  
  203. When PCBURM is run, it will display the users file/byte statistics. It
  204. will also display if the user is within your established ratio
  205. requirements, or if not, will inform him accordingly. In addition,
  206. PCBURM will maintain a log file (PCBURM.LOG) which will indicate what
  207. actions were taken by the program, or if the user was within ratio
  208. requirements. You may wish to delete this file regularly as necessary.
  209.  
  210.  
  211.  
  212.  
  213.                               REGISTRATION
  214.                               ============
  215.  
  216. PCBURM is released as user support software (aka SHAREWARE). I don't
  217. expect you to register the program if you don't like it or if it doesn't
  218. meet your needs (just stop using it). But if you continue to use PCBURM
  219. after a reasonable evaluation period of up to 30 days, you are required
  220. to make payment for the program or stop using it.
  221.  
  222. PCBURM is NOT crippled in any way other than for a momentary reminder at
  223. the termination of the program that the program is not registered. Once
  224. you register the program, you will be provided with a registration
  225. number which will remove this reminder notice.
  226.  
  227. Registration is only $15 and will include unlimited free upgrades and
  228. support via my BBS.
  229.  
  230. Please use the form REGISTER.FRM included with the program to register
  231. PCBURM. If this file is missing, send a check for $15 (US funds) to:
  232.  
  233.         Robert Neal
  234.         317 Hickory
  235.         Romeoville, IL  60441
  236.  
  237. Please include your BBS name as this information will be used to create
  238. your unique registration key file. You may receive your registration
  239. file via my support BBS (but please be sure you have an account
  240. established on my BBS so that I can leave this information in a private
  241. message to you) or via the US Mail. Please indicate your preference.
  242.  
  243. Keep your eye open for other utility programs from me written for
  244. PCBoard. Several programs are now in the works and should be released
  245. soon. Also, look for my door programs, Card Sharks and Links Golf
  246. (available on my BBS as well), I think your users will enjoy playing
  247. them.
  248.  
  249.  
  250.  
  251.                                   SUPPORT
  252.                             ===================
  253.  
  254. If you have any questions, comments, problems, suggestions for
  255. enhancements, etc., I may be reached at my support BBS or by mail. In
  256. addition, you may send a message to me on the RIME conferences to my BBS
  257. "CHQBBS", I regularly monitor the messages in the Sysop, BBS and PCBoard
  258. Support conferences. I can also be reached via Prodigy, PNSP01A.
  259.  
  260.  
  261.  
  262.                              LEGAL INFORMATION
  263.                       ===============================
  264.  
  265. This program is provided on an "AS IS" basis.  No warranty of any kind is
  266. expressed or implied.  YOU USE THIS PROGRAM AT YOUR OWN RISK.  I take no
  267. responsibility for any damage caused directly or indirectly from the use or
  268. the inability to use this program.
  269.  
  270.